7. Validation

Grails의 제약조건은 유효성 검사 규칙을 명시하는 것을 말한다. 대부분의 경우 도메인 클래스(domain classes)에 정의하지만 URL 매핑(URL Mappings)과 일반 객체(Command Objects)에도 정의할 수 있다.

7.1 Declaring Constraints

class User {
    String login
    String password
    String email
    Integer age    static constraints = {
	  …
    }
}

constraints 블럭에 속성의 이름과 일치하는 메소드를 호출하고 네임드 파라미터를 사용하여 제약조건을 명시한다:

class User {
    ...    static constraints = {
        login(size:5..15, blank:false, unique:true)
        password(size:5..15, blank:false)
        email(email:true, blank:false)
        age(min:18, nullable:false)
    }
}

이 예제의 login 속성 값은 5에서 15 사이로 문자열의 길이를 제한하고, 공백이 될 수 없고, 유일(unique)해야 한다. 그 뿐만 아니라 password, email, age 속성에도 제약조건을 정의했다.

7.2 Validating Constraints

Validation Basics(유효성 검사의 기초)

도메인 클래스의 유효성을 검사하기 위해 모든 인스턴스의 validate 메소드를 호출할 수 있다:

def user =  new User(params)if(user.validate()) {
    // do something with user
}
else {
    user.errors.allErrors.each {
        println it
    }
}

도메인 클래스의 errors 속성은 Spring의 Errors 인터페이스의 인스턴스이다. Errors 인터페이스는 유효성 검사의 에러를 살펴보는(navigate) 방법과 원래 값을 얻어 오는 방법을 제공한다.

Validation Phases(유효성 검사 시점)

Grails의 유효성 검사는 본질적으로 두 가지로 나뉜다. 먼저 다음과 같이 인스턴스에 요청 파리미터를 바인딩(data binding)할 때 유효성이 검사된다:

def user = new User(params)

이 시점에서 String을 Date로 변환하는 것 같은 형 변환 에러가 errors 속성에 이미 넣어진다. Errors API를 이용해 이 에러를 확인하고 원래 값을 얻을 수 있다:

if(user.hasErrors()) {
	if(user.hasFieldError("login")) {
		println user.getFieldError("login").rejectedValue
	}
}

validate나 save를 호출될 때도 유효성이 검사된다. 이 때 constraints 속성에 정의한 조건에 만족하는지 검사된다. 기본적으로 영속적 save 메소드는 유효성을 검사하기 때문에 다음과 같이 코드를 작성할 수 있다:

if(user.save()) {
    return user
}
else {
    user.errors.allErrors.each {
        println it
    }
}

7.3 Validation on the Client

Displaying Errors(에러 출력하기)

보통 유효성 검사 에러가 발생하면 그 뷰를 다시 보여줘야 할 것이고 에러를 출력할 어떤 방법이 필요하다. Grails에는 에러를 처리하는 태그들이 많이 있다. renderErrors를 사용하여 단순히 에러의 목록을 출력할 수 있다:

<g:renderErrors bean="${user}" />

<g:hasErrors bean="${user}">
  <ul>
   <g:eachError var="err" bean="${user}">
       <li>${err}</li> 
   </g:eachError>
  </ul>
</g:hasErrors>

Highlighting Errors(에러 꾸미기)

잘못된 값이 입력되면 붉은 박스나 어떤 지시자를 사용하여 꾸미는 것이 매우 유용하다. 이 것은 hasErrors를 메소드처럼 호출하여 처리한다:

<div class='value ${hasErrors(bean:user,field:'login','errors')}'>
   <input type="text" name="login" value="${fieldValue(bean:user,field:'login')}"/>
</div>

이 코드가 하는 일은 user Bean과 관련된 login 필드에 에러가 있는지 검사하고 에러가 있으면 div 태그의 class 속성에 “errors”를 추가한다. 그래서 CSS 규칙을 정의하여 div 태그를 꾸밀 수 있다.

Retrieving Input Values(입력 값 가져오기)

각각의 에러는 실질적으로 Spring의 FieldError 클래스의 인스턴스이다. 이 인스턴스에는 원래 값이 저장돼 있다. 이 것은 fieldValue 태그를 통해서 사용자가 입력 값을 고칠 수 있도록 에러 값을 재사용할 수 있다.

<input type="text" name="login" value="${fieldValue(bean:user,field:'login')}"/>

이 코드는 user Bean에 FieldError가 있는지 확인하고 만약 존재하면 login 필드에 입력된 값을 다시 넣는다.

7.4 Validation and Internationalization

Constraints and Message Codes(제약조건과 메시지 코드)

메시지 코드 자체는 관례에 따른다. 예를 들어 위에 예시했던 제약조건을 살펴보면:

class User {
    ...    static constraints = {
        login(size:5..15, blank:false, unique:true)
        password(size:5..15, blank:false)
        email(email:true, blank:false)
        age(min:18, nullable:false)
    }
}

blank 제약 조건을 위반하게 되면 Grails는 다음과 같은 관례에 따라 메시지를 찾는다:

[Class Name].[Property Name].[Constraint Code]

blank 제약 조건을 위반한 경우에의 메시지 코드는 user.login.blank가 될 것이기 때문에 grails-app/i18n/messages.properties 파일에 다음과 같이 메시지를 정의해야 한다:

user.login.blank=Your login name must be specified!

어떤 제약조건이 어떤 메시지 코드를 사용하는 지를 알고 싶다면 레퍼런스 가이드를 참고하라.

Displaying Messages(메시지 출력하기)

renderErrors 태그는 자동으로 message 태그에 사용할 메시지를 찾는다. 하지만 다음과 같이 원하는 대로 메시지를 출력할 수 있다:

<g:hasErrors bean="${user}">
  <ul>
   <g:eachError var="err" bean="${user}">
       <li><g:message error="${err}" /></li> 
   </g:eachError>
  </ul>
</g:hasErrors>

이 예제에서는 에러 메시지를 읽어오기 위해 eachError 태그의 바디에 message 태그를 넣고 err 인자를 사용했다.